Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

removed references to documentation from external sources #4106

Merged
merged 3 commits into from
Nov 11, 2014
Merged

removed references to documentation from external sources #4106

merged 3 commits into from
Nov 11, 2014
+39 −108

Conversation

fabpot
Copy link
Member

@fabpot fabpot commented Aug 8, 2014

Q A
Doc fix? n/a
New docs? n/a
Applies to all
Fixed tickets n/a

Referencing external doc sources was a mistake as the versioning can be (and is) different from the versioning of the Symfony docs.

WARNING I will merge this one myself to coordinate the merge with the release of the new frontend on symfony.com.

@xabbuh
Copy link
Member

xabbuh commented Aug 8, 2014

@fabpot Can we then also remove the install.sh script and modify the .travis.yml file accordingly? Or are those still needed for the new process?

@fabpot
Copy link
Member Author

fabpot commented Aug 8, 2014

@xabbuh Correct, I was not aware of these files. Fixed now.

@xabbuh
Copy link
Member

xabbuh commented Aug 8, 2014

@fabpot And one other thing: How do we handle doc directives referencing documents from the bundles directory (actually, that's why the Travis build fails)? I guess we have to link with absolute URLs then? This must be taken into account once we know where these docs can be viewed.

@weaverryan
Copy link
Member

@xabbuh @fabpot Yes, we will need to turn this into absolute links, which I think is fine.

Fabien, if you agree, you can do it or one of us can fork you and change the references.

@wouterj
Copy link
Member

wouterj commented Aug 10, 2014

Awesome! I can't wait for this to be merged.

@wouterj
Copy link
Member

wouterj commented Aug 11, 2014

The step "(Optionally) Install the bundle docs and CMF docs: bash install.sh;" should also be removed from http://symfony.com/doc/current/contributing/documentation/format.html#testing-documentation

@fabpot
Copy link
Member Author

fabpot commented Aug 11, 2014

@wouterj done

@wouterj
Copy link
Member

wouterj commented Aug 11, 2014

@fabpot I created a PR which removes even more references to third party docs: fabpot#1

And do these entries in the redirection map still work?

/cookbook/doctrine/migrations /bundles/DoctrineFixturesBundle/index
/cookbook/doctrine/doctrine_fixtures /bundles/DoctrineFixturesBundle/index
/cookbook/doctrine/mongodb /bundles/DoctrineMongoDBBundle/index

wouterj
wouterj reviewed Aug 11, 2014
View reviewed changes
book/doctrine.rst
* :doc:`/bundles/DoctrineFixturesBundle/index`
* :doc:`/bundles/DoctrineMongoDBBundle/index`
* :doc:`DoctrineFixturesBundle`
* :doc:`DoctrineMongoDBBundle`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry, my fault: The :doc: prefix should be removed and they both have to be suffixed with _

@fabpot
Copy link
Member Author

fabpot commented Nov 11, 2014

merging now!

@fabpot fabpot merged commit 2cb8d27 into symfony:2.3 Nov 11, 2014
fabpot added a commit that referenced this pull request Nov 11, 2014
@fabpot
minor #4106 removed references to documentation from external sources…
41bc061 
… (fabpot, WouterJ)

This PR was merged into the 2.3 branch.

Discussion
----------

removed references to documentation from external sources

| Q             | A
| ------------- | ---
| Doc fix?      | n/a
| New docs?     | n/a
| Applies to    | all
| Fixed tickets | n/a

Referencing external doc sources was a mistake as the versioning can be (and is) different from the versioning of the Symfony docs.

**WARNING** I will merge this one myself to coordinate the merge with the release of the new frontend on symfony.com.

Commits
-------

2cb8d27 removed more references to documentation from external sources
c39ea1d Removed more references to third party docs
0e2c491 removed references to documentation from external sources
@fabpot
Copy link
Member Author

fabpot commented Nov 11, 2014

The website has been updated now. As you can see for yourself, each bundle and the Symfony CMF have their own versions now. It took a lot of time to get there, and I'm very happy to have finished this one.

The code has been drastically changed so hopefully, I don't have introduced too many regressions.

@xabbuh
Copy link
Member

xabbuh commented Nov 11, 2014

@fabpot Pretty cool, thank you!

There is one additional external reference which had to be changed. Can you have a look at #4442?

This was referenced Nov 12, 2014
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Status: Reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@fabpot @xabbuh @weaverryan @wouterj